/*
 * Copyright @ 2010 Radomir Mladenovic and BugsIO Solutions
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *       http://www.apache.org/licenses/LICENSE-2.0
 *       
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.googlecode.gjutil.caching;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Mark a method that you want to use for putting an object to memcached.
 * The last method argument will be put to cache while the
 * annotation value and all arguments except the last one will be used for cache key generation.
 * The method must have at least two arguments.
 * Annotation value defines base cache key.   
 *
 * Keep the method body empty. 
 * 
 * @author radomir
 *
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MemCacheSetter {
	
	String group();
	
	String cache() default "";
	
	/** Defines expiration for some seconds in the future. */
	int expirationSeconds() default 0;
	
	/** Defines whether to cache null values. Default is false. **/
//	boolean cacheNull() default false;	
}
